home *** CD-ROM | disk | FTP | other *** search
/ Carousel / CAROUSEL.cdr / mactosh / da / talkmoos.sit / About Moose < prev    next >
Text File  |  1987-05-17  |  13KB  |  214 lines
  1.  
  2.                               The Talking Moose Desk Accessory.
  3.  
  4. About the Talking  Moose:   (version 1.21)
  5.         The Moose is my attempt to give the Macintosh a talking personality.
  6. The first Moose would speak (sometimes) humorous comments when the
  7. user was not doing anything.  This new version also allows applications
  8. to say specific phrases. (Other improvements too.)
  9.         When the Talking Moose D.A. is first opened,  the code for the Moose 
  10. is installed into the System Heap.  This is a special area of shared memory
  11. that allows the Moose to stay installed, even if you change applications.
  12. The Moose requires 2 files to be present in order to work:  "MacinTalk¬",
  13. and "Moose Phrases".  These 2 files  should be kept in the System Folder.
  14. (Please remember this when giving the Moose D.A. to someone else.)
  15.  
  16. About the Author and Public Domain:
  17.         For info, copies of the Moose or source code,  or if you want to report 
  18. problems or suggestions, contact:  Steve Halls,  11135-50 ave, Edmonton, 
  19. Alberta, CANADA, T6H 0J1.     For $15, I'll mail you the latest Moose and 
  20. utilities, and the source code if you want.   (Can you download 2 full disks
  21. for $15?  I can't.)   The Moose D.A's, utilities, and  source code are all still
  22. public domain, so spread it around.  
  23.         If you place the Moose on a BBS, please try to keep the files together,
  24. and inform the on-line users which (if any) files are missing.    Please
  25. remove older versions of the files.   I would also appreciate hearing about
  26. download-counts, and interesting uses  of the Moose.
  27.  
  28. About this Disk:
  29.        The System file on this Disk is Version 4.1.  It contains 3 new Desk
  30. Accessories:  The Talking Moose,  a Speech Testing D.A, and a Phoneme 
  31. Reference D.A..   However, to make room, the non-essential fonts, D.A's and
  32. support files have been removed from this System.  To obtain a complete
  33. System with all the fonts and support files, contact your local Apple dealer.
  34. The current Finder is version 5.5.  I have added some extra extra resources,
  35. to make the Finder talk.
  36.  
  37. Whats new in Version 1.21:
  38.        The Delay has been considerably lengthened, so it won't get on your 
  39. nerves so quickly.  The Moose now talks when the Mac asks you to Insert a 
  40. Disk.  Applications can be made to talk by adding resources.  Pascal 
  41. programmers can completely control the Moose.  The "Moose Phrases" file 
  42. contains some new resources.  Partial Switcher¬ compatibility  has been 
  43. added.  There are many internal improvements. 
  44.  
  45. How to install the Moose:
  46.        The "Talking Moose" is a simple Desk Accessory that can be moved into 
  47. any System using the Font/DA Mover.  The files "MacinTalk" and "Moose 
  48. Phrases" should be copied onto any System Disk that you use.  As an 
  49. alternative, there is an Installer script that will do all that for you.
  50. (However, turn off the Moose before running the Installer.  The Installer
  51. and scripts are kept in the System Folder, to help the Installer find files.)
  52.  
  53. About the Speech Tester D.A:
  54.        This desk accessory lets you type in text, and have it converted into 
  55. phonemes.  You can then copy these phonemes, and paste them elsewhere.  
  56. This is particularly handy to do in ResEdit, while editing "Moose Phrases".
  57.  
  58. About SwitchMoose:
  59.         "SwitchMoose" is a utility program that has several functions:  
  60. 1st, It allows the Moose to work while Switcher is active. 
  61. 2nd, As the Startup application, it installs the Moose automatically. 
  62. 3rd, It sets Moose parameters like Rate, Pitch, Delay, etc.
  63. 4th, It has a rudimentary ability to add phrases to "Moose Phrases".
  64.  
  65. About ResEdit:
  66.         ResEdit is a powerful Resource Editor (version 1.1d3) from Apple
  67. that is useful for changing Moose Phrases, and making applications talk,
  68. (and many other things too.)  Although newer versions of ResEdit are
  69. likely available,  the version on this disk has special "templates" (TMPLs)
  70. for editing the Moose's talking resources... (more on this below).  If
  71. you want to use a newer ResEdit version, be sure to move these TMPLs
  72. into your version. (Just the MooD,MooA,MooM templates need be moved.)
  73.  
  74. How to change the phrases:
  75.        Although simple programs like "Moose Frazer" (and "SwitchMoose")
  76. can add phrases,  for complete control, using ResEdit is best.  Detailed
  77. instructions are available in a separate document,  but here is a simple
  78. review of how to use ResEdit to change phrases.
  79. - In ResEdit, open the file "Moose Phrases" (by double clicking on it.)
  80. - A list of the resources will appear.  (There may be only 1 kind.)
  81. - Double click on the  'STR#' type, and see the different names available.
  82.    "Pauses" get said during delays. Open up the "Pauses", and you will see a
  83.     list of phoneme strings. (These are the strings you will be changing.)
  84. - Using the SpeechTester DA, you can type in text, and see it converted
  85.    to phonemes, and you can Copy the phonemes, ready to be pasted.
  86. - Editing Moose Phrases again, To add room for more phrases, click on 
  87.    a "*****" line, and choose "New". (This creates room for a new string)
  88.    Then paste a phrase into the new string.
  89. -Continue this process till you run out of ideas.  Then Close and Save it.
  90.  
  91. How to make applications talk:
  92.        The Moose has a special new ability.  You can add resources into almost 
  93. any application.  The Moose will check to see if the resources are present,  
  94. and if so,  will use them to determine how to talk.  There is an Installer 
  95. script for Finder 5.5 and Finder 4.1, which installs these resources 
  96. automatically.  In ResEdit, you can then edit the data, and/or copy and
  97. move these resources into other applications.  The technical details about
  98. these resources is described below.  Skip to the next topic if you wish.
  99. I hope other interested people will create resources (and installer scripts)
  100. for making other applications talk as well.
  101.   (Samples of all needed resources are available in the Finder on this disk)
  102.   Put a 'Moos' resource in the application  (Set ID=0.  This contains
  103.      code that patches things to do the talking.)
  104.   For Menus, add a 'MooM' resource,  For Alerts, add a 'MooA' resource.
  105.   For Dialogs, add a 'MooD' resource.  (These resources, if present, must 
  106.     have ID=0. They will contain the editable data that you provide which
  107.     tells how to speak things.)
  108.   Add a 'STR#' resource (any ID) to hold the new phrases you may create.
  109.   The tools you need are:  ResEdit, the Moose, and the Speech Tester DA.
  110.   In ResEdit, you can open your application, and inspect it's ALRTs,
  111.     DLOGs, and MENUs.  (Its fun to change these, but that's another story)
  112.   To begin,  add the Moos,MooD,MooA,MooM ▒ STR# resources to your
  113.      target application, by copying them out of the Finder. 
  114.     (Eg: Open Finder, Open 'Moos', Open ID=0, Copy, Close windows, 
  115.           Open Target application,  "New" Moos,  Paste, Close windows.)
  116.   Create a "New" STR#, with any ID, no need to copy from elsewhere.
  117.   Editing the MooM,MooA,MooDs in turn:
  118.       (This requires that your version of ResEdit has the proper TMPLs
  119.         or "Editing Templates" in it.  The TMPLs  give names to the
  120.         various data fields that you will be editing.  A brief description
  121.          of editing these fields is given below:)
  122.       - Record the ID of the STR# which will hold phoneme phrases.
  123.       - "Translate unmatched", if set to "1", means the Moose will attempt
  124.          to translate any MENUs,ALRTs,DLOGs, that you haven't explicitly 
  125.          defined. (If left blank, no translating done).  (for ALRTs and DLOGs,
  126.          a number >0 specifies the n'th  _TextBox will be translated... this
  127.          requires some experimentation for some DLOGs.)
  128.       - Click on the "*****" and choose "New"  each time you want to create 
  129.         a new record for each MENU,ALRT,DLOG.
  130.       - Suppose you created a New MENU record.  Heres how to edit it.
  131.           - Enter the ID of the MENU.  (Eg, 1 is usually the apple menu).
  132.           - Another "Translate unmatched" here only applies to non-defined
  133.              menu  items from this MENU ID only. 
  134.           - Now, each MENU has items, and you may want to specify data
  135.              about how to speak a few of these.  So  for each item that needs 
  136.              specifying,  Click on the "-----", and choose  "New" to make a 
  137.              new item record.
  138.               - Enter the Item #.  Eg, in the 1st MENU, #1 item usually says 
  139.                  "About this program", so enter 1.
  140.               - Translate?, if 1 tells the Moose to try to translate the item. 
  141.                  This is useful for items that change text.   If 0, then you have 
  142.                  to provide specific phrases below.
  143.               - QuickTalk?, if 1 tells the Moose to speak right away (like 
  144.                  before a program gets a chance to quit).  Otherwise, the Moose 
  145.                  waits till nothing else is happening before speaking.
  146.               - Item if Checked?  If a number is entered here, and the
  147.                  current MENU item is checked,  the data from a different
  148.                  item record will be used for talking instead.
  149.               - Now, for any item, you can provide zero-to-many phrases. 
  150.                 (providing zero  is a way to exclude an item from being spoken, 
  151.                  when everything else gets said by default. If many, one is chosen 
  152.                  randomly.)
  153.               - To make a phrase, you use the SpeechTester DA. Type in text, 
  154.                  and  have it be changed into phonemes.  Edit the phonemes till 
  155.                  they sound  right, then Select and Copy the phonemes.
  156.               - To save the phrase, open the STR# resource, Click on the
  157.                 "*****" and choose "New". Then  Paste the phonemes in the new
  158.                 spot. Remember the string number.
  159.               (By now there are different windows all over the screen.  You 
  160.                have to return to the MooM window, to record the number
  161.                of the string you just created.)
  162.               - Click on the "+++++" in the "Available Phrases" list, Choose
  163.                  New, then type in the number of the  new string you created.
  164.               - At this point, at the of your 'MooM' resource, you see:
  165.                         +++++        <- Click here then add New string numbers.  or 
  166.                       -----          <- Click here then add New item records,  or
  167.                    *****            <- Click here then add New MENU records.
  168.  
  169.  
  170. About the source code:
  171.         All of the source code for the various Desk Accessories and utilities 
  172. is provided on the source code disk.  The Talking Moose Desk Accessory is 
  173. written entirely in Assembly language.  This makes it pretty much 
  174. incomprehensible to non-technical people. (Also note that it is MDS format,  
  175. and due to assembler problems,  I've been using the MDS assembler inside
  176. the Mac C compiler (v5.02).  Feel free to make changes or improvements to 
  177. the Moose and utilities.
  178.  
  179. About the Pascal interface:
  180.        The new Moose contains all the features of the original MacinTalk 
  181. interface,  plus all the Moose's extra abilities.  Pascal programmers can 
  182. include some "interface" code in their programs, and make direct calls to
  183. the Moose.  For example, there are Pascal routines to Install the Moose;
  184. set rate,pitch,etc;  to translate text into phonemes;  to ask the Moose to 
  185. speak something... plus much more.
  186.  
  187. Potential Problems:
  188.        Not enough SysHeap room.  If this happens,  use FEdit to increase the 
  189. allotted space for the System Heap on your startup disk.
  190.        Files not found.  "MacinTalk" and "Moose Phrases" should be located in 
  191. the System Folder of any System disk.  (P.S. there is a new "Moose Phrases"
  192. file, and some new Moose features won't work with the old file.)
  193.        You shouldn't put "talking resources" inside ResEdit, because ResEdit 
  194. fails to Exit normally... causing a crash in the next application.  (It zeros 
  195. the "IAZNotify" address, for technical people who understand this.)
  196.        The "talking resources" are disabled when running under Switcher.
  197.        I have heard that all MacinTalk programs do not (or did not) work on
  198. Hyperdrive-equipped Macs.   I've also heard that MacinTalk doesn't work
  199. on the new Macintosh IIs.  (Thus the Moose won't work either.)
  200.        There still seems to be problems with the Moose v1.2 when run
  201. on System 4.1.   I am working (slowly) to fix these... any advice is 
  202. appreciated.  If you encounter other situations where the Moose doesn't
  203. fully work, (like when running "Stepping Out¬"),  please let me know... 
  204. possibly by sending a disk with the offending setup.
  205.  
  206. Fancy things you can do:
  207.        Using ExceptionEdit,  you can create an exception file,  and then with 
  208. ResEdit,  you can copy the RULZ resource, and paste it into "Moose Phrases".  
  209. Then all applications will be able to access it.
  210.        You can add a greater assortment of phrases to the talking Finder
  211. resources, using ResEdit and the SpeechTester D.A.  You'll have to learn
  212. how to use ResEdit, and learn what the fields of the TMPLs mean.
  213.  
  214.